home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / chemv.z / chemv
Encoding:
Text File  |  2002-10-03  |  15.9 KB  |  331 lines

  1.  
  2.  
  3.  
  4. CCCCHHHHEEEEMMMMVVVV((((3333SSSS))))                                                            CCCCHHHHEEEEMMMMVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CCCCHHHHEEEEMMMMVVVV, ZZZZHHHHEEEEMMMMVVVV - Multiplies a complex vector by a complex Hermitian matrix
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      Single precision complex
  13.  
  14.           Fortran:
  15.                CCCCAAAALLLLLLLL CCCCHHHHEEEEMMMMVVVV ((((_u_p_l_o,,,, _n,,,, _a_l_p_h_a,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x,,,, *_b_e_t_a,,,, _y,,,, _i_n_c_y))))
  16.  
  17.           C/C++:
  18.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  19.                vvvvooooiiiidddd cccchhhheeeemmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_a_l_p_h_a,,,,
  20.                ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_a,,,, iiiinnnntttt _l_d_a,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _x,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx
  21.                *_b_e_t_a,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_y,,,, iiiinnnntttt _i_n_c_y))));;;;
  22.  
  23.           C++ STL:
  24.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  25.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  26.                vvvvooooiiiidddd cccchhhheeeemmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a_l_p_h_a,,,,
  27.                ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a,,,, iiiinnnntttt _l_d_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_x,,,, iiiinnnntttt _x,,,,
  28.                ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_b_e_t_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_y,,,, iiiinnnntttt _i_n_c_y))));;;;
  29.  
  30.      Double precision complex
  31.  
  32.           Fortran:
  33.                CCCCAAAALLLLLLLL ZZZZHHHHEEEEMMMMVVVV ((((_u_p_l_o,,,, _n,,,, _a_l_p_h_a,,,, _a,,,, _l_d_a,,,, _x,,,, _i_n_c_x,,,, _b_e_t_a,,,, _y,,,, _i_n_c_y))))
  34.  
  35.           C/C++:
  36.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  37.                vvvvooooiiiidddd zzzzhhhheeeemmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ssss ccccssssllll____zzzzoooommmmpppplllleeeexxxx *_a_l_p_h_a,,,,
  38.                ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_a,,,, iiiinnnntttt _l_d_a,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _x,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx
  39.                *_b_e_t_a,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_y,,,, iiiinnnntttt _i_n_c_y))));;;;
  40.  
  41.           C++ STL:
  42.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  43.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  44.                vvvvooooiiiidddd zzzzhhhheeeemmmmvvvv ((((cccchhhhaaaarrrr *_u_p_l_o,,,, iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_a_l_p_h_a,,,,
  45.                ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_a,,,, iiiinnnntttt _l_d_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_x,,,, iiiinnnntttt _x,,,,
  46.                ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_b_e_t_a,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_y,,,, iiiinnnntttt _i_n_c_y))));;;;
  47.  
  48. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  49.      These routines are part of the SCSL Scientific Library and can be loaded
  50.      using either the ----llllssssccccssss or the ----llllssssccccssss____mmmmpppp option.  The ----llllssssccccssss____mmmmpppp option
  51.      directs the linker to use the multi-processor version of the library.
  52.  
  53.      When linking to SCSL with ----llllssssccccssss or ----llllssssccccssss____mmmmpppp, the default integer size is
  54.      4 bytes (32 bits). Another version of SCSL is available in which integers
  55.      are 8 bytes (64 bits).  This version allows the user access to larger
  56.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  57.      by using the ----llllssssccccssss____iiii8888 option or the ----llllssssccccssss____iiii8888____mmmmpppp option. A program may use
  58.      only one of the two versions; 4-byte integer and 8-byte integer library
  59.      calls cannot be mixed.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHEEEEMMMMVVVV((((3333SSSS))))                                                            CCCCHHHHEEEEMMMMVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      The C and C++ prototypes shown above are appropriate for the 4-byte
  75.      integer version of SCSL. When using the 8-byte integer version, the
  76.      variables of type iiiinnnntttt become lllloooonnnngggg lllloooonnnngggg and the <<<<ssssccccssssllll____bbbbllllaaaassss____iiii8888....hhhh>>>> header
  77.      file should be included.
  78.  
  79. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  80.      These routines perform the following matrix-vector operation:
  81.  
  82.           _y <- _a_l_p_h_a _A_x + _b_e_t_a _y
  83.  
  84.      where _a_l_p_h_a and _b_e_t_a are scalars, _x and _y are _n-element vectors, and _A is
  85.      an _n-by-_n Hermitian matrix.
  86.  
  87.      See the NOTES section of this man page for information about the
  88.      interpretation of the data types described in the following arguments.
  89.  
  90.      These routines have the following arguments:
  91.  
  92.      _u_p_l_o      Character.  (input)
  93.                Specifies whether the upper or lower triangular part of array _a
  94.                is referenced, as follows:
  95.  
  96.                _u_p_l_o= 'U' or 'u': only the upper triangular part of _a is
  97.                referenced.
  98.                _u_p_l_o= 'L' or 'l': only the lower triangular part of _a is
  99.                referenced.
  100.  
  101.                For C/C++, a pointer to this character is passed.
  102.  
  103.      _n         Integer.  (input)
  104.                Specifies the order of matrix _A.  _n >= 0.
  105.  
  106.      _a_l_p_h_a     Scalar alpha.  (input)
  107.                CCCCHHHHEEEEMMMMVVVV: Single precision complex.
  108.                ZZZZHHHHEEEEMMMMVVVV: Double precision complex.
  109.  
  110.                For C/C++, a pointer to this scalar is passed.
  111.  
  112.      _a         Array of dimension (_l_d_a,_n).  (input)
  113.                CCCCHHHHEEEEMMMMVVVV: Complex array.
  114.                ZZZZHHHHEEEEMMMMVVVV: Double complex array.
  115.  
  116.                Before entry with _u_p_l_o = 'U' or 'u', the leading _n-by-_n upper
  117.                triangular part of array _a must contain the upper triangular
  118.                part of the Hermitian matrix.  The strictly lower triangular
  119.                part of _a is not referenced.
  120.  
  121.                Before entry with _u_p_l_o = 'L' or 'l', the leading _n-by-_n lower
  122.                triangular part of array _a must contain the lower triangular
  123.                part of the Hermitian matrix.  The strictly upper triangular
  124.                part of _a is not referenced.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHEEEEMMMMVVVV((((3333SSSS))))                                                            CCCCHHHHEEEEMMMMVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140.                The imaginary parts of the diagonal elements need not be set
  141.                and are assumed to be 0.
  142.  
  143.      _l_d_a       Integer.  (input)
  144.                Specifies the first dimension of _a as declared in the calling
  145.                program.
  146.                Argument _l_d_a >= MMMMAAAAXXXX(1,_n).
  147.  
  148.      _x         Array of dimension 1+(_n-1) * |_i_n_c_x|.  (input)
  149.                CCCCHHHHEEEEMMMMVVVV: Single precision complex array.
  150.                ZZZZHHHHEEEEMMMMVVVV: Double precision complex array.
  151.                Contains vector _x.
  152.  
  153.      _i_n_c_x      Integer.  (input)
  154.                Specifies the increment for the elements of _x.  _i_n_c_x must not
  155.                be 0.
  156.  
  157.      _b_e_t_a      Scalar beta.  If _b_e_t_a is supplied as 0, _y need not be set on
  158.                input.
  159.                CCCCHHHHEEEEMMMMVVVV: Single precision complex.
  160.                ZZZZHHHHEEEEMMMMVVVV: Double precision complex.
  161.  
  162.                For C/C++, a pointer to this scalar is passed.
  163.  
  164.      _y         Array of dimension 1+(_n-1) * |_i_n_c_y|.  (input and output)
  165.                CCCCHHHHEEEEMMMMVVVV: Single precision complex array.
  166.                ZZZZHHHHEEEEMMMMVVVV: Double precision complex array.
  167.                Contains vector _y.  On exit, the updated vector overwrites
  168.                array _y.
  169.  
  170.      _i_n_c_y      Integer.  (input)
  171.                Specifies the increment for the elements of _y.  _i_n_c_y must not
  172.                be 0.
  173.  
  174. NNNNOOOOTTTTEEEESSSS
  175.      CCCCHHHHEEEEMMMMVVVV/ZZZZHHHHEEEEMMMMVVVV is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).
  176.  
  177.      When working backward (_i_n_c_x < 0 or _i_n_c_y < 0), this routine starts at the
  178.      end of the vector and moves backward, as follows:
  179.  
  180.           _x(1-_i_n_c_x * (_n-1)), _x(1-_i_n_c_x * (_n-2)) , ..., _x(1)
  181.  
  182.           _y(1-_i_n_c_y * (_n-1)), _y(1-_i_n_c_y * (_n-2)) , ..., _y(1)
  183.  
  184.  
  185.    DDDDaaaattttaaaa TTTTyyyyppppeeeessss
  186.      The following data types are described in this documentation:
  187.  
  188.           TTTTeeeerrrrmmmm UUUUsssseeeedddd                          DDDDaaaattttaaaa ttttyyyyppppeeee
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CCCCHHHHEEEEMMMMVVVV((((3333SSSS))))                                                            CCCCHHHHEEEEMMMMVVVV((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      Fortran:
  207.  
  208.           Array dimensioned _n           xxxx((((nnnn))))
  209.  
  210.           Array of dimensions (_m,_n)     xxxx((((mmmm,,,,nnnn))))
  211.  
  212.           Character                     CCCCHHHHAAAARRRRAAAACCCCTTTTEEEERRRR
  213.  
  214.           Integer                       IIIINNNNTTTTEEEEGGGGEEEERRRR (IIIINNNNTTTTEEEEGGGGEEEERRRR****8888 for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  215.  
  216.           Single precision complex      CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  217.  
  218.           Double precision complex      DDDDOOOOUUUUBBBBLLLLEEEE CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  219.  
  220.      C/C++:
  221.  
  222.           Array dimensioned _n           xxxx[[[[_n]]]]
  223.  
  224.           Array of dimensions (_m, _n)    xxxx[[[[mmmm****nnnn]]]]
  225.  
  226.           Character                     cccchhhhaaaarrrr
  227.  
  228.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  229.  
  230.           Single precision complex      ssssccccssssllll____ccccoooommmmpppplllleeeexxxx
  231.  
  232.           Double precision complex      ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx
  233.  
  234.      C++ STL:
  235.  
  236.           Array dimensioned _n           xxxx[[[[_n]]]]
  237.  
  238.           Array of dimensions (_m, _n)    xxxx[[[[mmmm****nnnn]]]]
  239.  
  240.           Character                     cccchhhhaaaarrrr
  241.  
  242.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  243.  
  244.           Single precision complex      ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>
  245.  
  246.           Double precision complex      ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>>
  247.  
  248.      Note that you can explicitly declare multidimensional C/C++ arrays
  249.      provided that the array dimensions are swapped with respect to the
  250.      Fortran declaration (e.g., xxxx[[[[nnnn]]]][[[[mmmm]]]] in C/C++ versus xxxx((((mmmm,,,,nnnn)))) in Fortran).
  251.      To avoid a compiler type mismatch error in C++ (or a compiler warning
  252.      message in C), however, the array should be cast to a pointer of the
  253.      appropriate type when passed as an argument to a SCSL routine.
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. CCCCHHHHEEEEMMMMVVVV((((3333SSSS))))                                                            CCCCHHHHEEEEMMMMVVVV((((3333SSSS))))
  269.  
  270.  
  271.  
  272. SEE ALSO
  273.      IIIINNNNTTTTRRRROOOO____SSSSCCCCSSSSLLLL(3S), IIIINNNNTTTTRRRROOOO____BBBBLLLLAAAASSSS2222(3S), SSSSSSSSYYYYMMMMVVVV(3S)
  274.  
  275.      IIIINNNNTTTTRRRROOOO____CCCCBBBBLLLLAAAASSSS(3S) for information about using the C interface to Fortran 77
  276.      Basic Linear Algebra Subprograms (legacy BLAS) set forth by the Basic
  277.      Linear Algebra Subprograms Technical Forum.
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.                                                                         PPPPaaaaggggeeee 5555
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.